\name{VAObject-class}
\Rdversion{1.1}
\docType{class}
\alias{VAObject-class}
\alias{VASummaryObject-class}

\title{Class "VAObject"}
\description{A class to hold Visual Acuity data for the oculus sinister (OS; left eye) and oculus dexter (OD; right eye)  Class \code{VASummaryObject} contains \code{VAObject}.
}

\section{Objects from the Class}{
Objects can be created by calls of the form \code{new("VAObject", ...)} or \code{new("VASummaryObject")}.  Calling \code{summary} on a \code{VAObject} will produce a \code{VASummaryObject} which extends \code{VAObject} by adding logMAR and snellen values combined from both eyes as well as the overall arithmetic mean of the logMAR values.
}

\section{Slots}{
  \describe{
    \item{\code{logMAR.combined}:}{Object of class \code{"numeric"} for the logMAR values combined from the left and right eyes.}
    \item{\code{snellen.combined}:}{Object of class \code{"character"} for the snellen values back transformed from the combined logMAR values.}
    \item{\code{mean.logMAR}:}{Object of class \code{"numeric"} for the mean combined logMAR value.}
    \item{\code{mean.snellen}:}{Object of class \code{"character"} for the mean combined snellen value back transformed from the mean logMAR value.}
    \item{\code{originalOS}:}{Object of class \code{"ANY"} the original visual acuity data for the left (ocular sinister) eye.}
    \item{\code{originalOD}:}{Object of class \code{"ANY"} the original visual acuity data for the right (ocular dexter) eye.}
    \item{\code{logMAROS}:}{Object of class \code{"numeric"} the visual acuity data for OS converted to logMAR units.}
    \item{\code{logMAROD}:}{Object of class \code{"numeric"} the visual acuity data for OD converted to logMAR units.}
    \item{\code{chart.values}:}{Object of class \code{"character"} the snellen values for each line of the chart used to measure visual acuity.  Used for the linear interpolation in the case of partially correct line readings.}
    \item{\code{chart.nletters}:}{Object of class \code{"integer"} the number of letters on each line of the chart used to measure visual acuity.  Used for the linear interpolation in the case of partially correct line readings (+2 is 2/4 of the way to the next line if there are four letters, but only 2/6 if there are six, etc.)}
    \item{\code{zero}:}{Object of class \code{"numeric"} the logMAR value chosen to represent "zero" visual acuity when creating the combined logMAR values for both eyes or taking the arithmetic mean.}
  }
}

\author{Joshua Wiley, \url{http://joshuawiley.com/}}


\seealso{\code{\link{VAConverter}}, \code{\link{ValidVAObject}}, \code{\linkS4class{VASummaryObject}}
}

\examples{
showClass("VAObject")

showClass("VASummaryObject")
}

\keyword{classes}
